Add CI build settings and README updates #7
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds basic CI build settings for automated testing and improves README documentation with formatting fixes and code example updates. The changes include setting up GitHub Actions CI workflow and standardizing code formatting in README examples.
- Added GitHub Actions CI workflow for build, test, and lint automation
- Fixed README directory references and improved code example formatting
- Updated test configuration to set required environment variable
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .github/workflows/ci.yml | Adds CI workflow for automated build, test, and lint processes |
| README.md | Fixes directory references, improves code formatting, and updates import statements |
| src/tests/unit/agents.test.ts | Sets OPENAI_API_KEY environment variable for test execution |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| - `src/checks/` - Built-in guardrail checks | ||
| - `src/evals/` - Evaluation framework | ||
| - `src/examples/` - Example usage and sample data | ||
| - `examples/` - Example usage and sample data |
There was a problem hiding this comment.
The project structure indicates examples are in examples/ directory, but the examples section below shows running examples from examples/basic/ subdirectory. This inconsistency could confuse users about the actual directory structure.
Copilot uses AI. Check for mistakes.
|
|
||
| try { | ||
| const response = await client.responses.create({ | ||
| model: 'gpt-5', |
There was a problem hiding this comment.
The model 'gpt-5' does not exist in OpenAI's API. This should use an actual model like 'gpt-4' or 'gpt-3.5-turbo' to ensure the example works correctly.
| model: 'gpt-5', | |
| model: 'gpt-4', |
Copilot uses AI. Check for mistakes.
This pull request adds:
As @gabor-openai and I discussed, I've changed the indentation in code snippets from 4 spaces to 2 spaces for README. I will come up with a separate PR to consistently apply the same to all code and examples.